<html>
<head>
<title>Docs For Class ProFTPD_MySQL_Controller</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">default</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ]
		  [ <a href="../elementindex_default.html" class="menu">index: default</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="../li_default.html">default</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../default/_Config_class_php.html">		Config.class.php
		</a><br>
			<a href="../default/_Controllers_Controller_php.html">		Controller.php
		</a><br>
			<a href="../default/_Exceptions_classes_php.html">		Exceptions.classes.php
		</a><br>
			<a href="../default/_Controllers_FTP_Controller_php.html">		FTP_Controller.php
		</a><br>
			<a href="../default/_Controllers_FTP_ProFTPD_MySQL_controller_php.html">		ProFTPD_MySQL.controller.php
		</a><br>
			<a href="../default/_Syslog_class_php.html">		Syslog.class.php
		</a><br>
			<a href="../default/_TCE-lib_php.html">		TCE-lib.php
		</a><br>
	  </div><br />
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../default/Config.html">Config</a><br />
	    		<a href="../default/ConfigException.html">ConfigException</a><br />
	    		<a href="../default/ConfigInvalidException.html">ConfigInvalidException</a><br />
	    		<a href="../default/ConfigResult.html">ConfigResult</a><br />
	    		<a href="../default/Controller.html">Controller</a><br />
	    		<a href="../default/DatabaseException.html">DatabaseException</a><br />
	    		<a href="../default/FileException.html">FileException</a><br />
	    		<a href="../default/FileNotFoundException.html">FileNotFoundException</a><br />
	    		<a href="../default/FileReadException.html">FileReadException</a><br />
	    		<a href="../default/FileWriteException.html">FileWriteException</a><br />
	    		<a href="../default/FTP_Controller.html">FTP_Controller</a><br />
	    		<a href="../default/LanguageClassNotFoundException.html">LanguageClassNotFoundException</a><br />
	    		<a href="../default/LanguageException.html">LanguageException</a><br />
	    		<a href="../default/LanguageFileNotFoundException.html">LanguageFileNotFoundException</a><br />
	    		<a href="../default/ProFTPD_MySQL_Controller.html">ProFTPD_MySQL_Controller</a><br />
	    		<a href="../default/Syslog.html">Syslog</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: ProFTPD_MySQL_Controller</h1>
Source Location: /Controllers/FTP/ProFTPD_MySQL.controller.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre><a href="../default/Controller.html">Controller</a>
   |
   --<a href="../default/FTP_Controller.html">FTP_Controller</a>
      |
      --ProFTPD_MySQL_Controller</pre><br />
<div class="description">Controller frontend to a ProFTPd with MySQL support build in</div><br /><br />







</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodcanDisable">canDisable</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodcanHandleQuota">canHandleQuota</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodcanKillConnections">canKillConnections</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodcanListConnections">canListConnections</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodcreateUser">createUser</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methoddeleteUser">deleteUser</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methoddisableUser">disableUser</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodenableUser">enableUser</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodendInterface">endInterface</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodgetConfigFields">getConfigFields</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodgetControllerInfo">getControllerInfo</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodgetHardLimit">getHardLimit</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodgetServerStatus">getServerStatus</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodgetSoftLimit">getSoftLimit</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodkillAllConnections">killAllConnections</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodkillConnection">killConnection</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodlistConnections">listConnections</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodlistUsers">listUsers</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodsetConfigFields">setConfigFields</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodsetQuota">setQuota</a></li>
    <li><a href="../default/ProFTPD_MySQL_Controller.html#methodstartInterface">startInterface</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>





<td valign="top">
<h3>Inherited Methods</h3>
<div class="tags">
<h4>Class: <a href="../default/FTP_Controller.html">FTP_Controller</a></h4>
<dl>
    <dt>
    <a href="../default/FTP_Controller.html#methodcanDisable">FTP_Controller::canDisable()</a>
  </dt>
  <dd>
    Return true if the controller can disable/enable ftp accounts
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodcanHandleQuota">FTP_Controller::canHandleQuota()</a>
  </dt>
  <dd>
    Return true if the controller can handle quotas
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodcanKillConnections">FTP_Controller::canKillConnections()</a>
  </dt>
  <dd>
    Return true if the controller can kill a ftp connections
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodcanListConnections">FTP_Controller::canListConnections()</a>
  </dt>
  <dd>
    Return true if the controller can list current ftp connections
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodcreateController">FTP_Controller::createController()</a>
  </dt>
  <dd>
    Creates a new instance of $ControllerClass if $Persistent is set to false
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodcreateUser">FTP_Controller::createUser()</a>
  </dt>
  <dd>
    Creates a new FTP user with the given $Homedir
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methoddeleteUser">FTP_Controller::deleteUser()</a>
  </dt>
  <dd>
    Delete the given user
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methoddisableUser">FTP_Controller::disableUser()</a>
  </dt>
  <dd>
    Disable the given user
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodenableUser">FTP_Controller::enableUser()</a>
  </dt>
  <dd>
    Enable the given user
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodendInterface">FTP_Controller::endInterface()</a>
  </dt>
  <dd>
    Stop interfacing with the FTP server
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodgetConfigFields">FTP_Controller::getConfigFields()</a>
  </dt>
  <dd>
    Returns an array of the information that is needed to handle the ftp server (db_name and so on)
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodgetControllerInfo">FTP_Controller::getControllerInfo()</a>
  </dt>
  <dd>
    Should return an array like this return array('Name' =&gt; 'FTP Controller', 'Description' =&gt; 'A FTP Controller');
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodgetHardLimit">FTP_Controller::getHardLimit()</a>
  </dt>
  <dd>
    Gets the hard limit for a FTP user
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodgetServerStatus">FTP_Controller::getServerStatus()</a>
  </dt>
  <dd>
    Returns information about the ftp server  Every class should return array('Version' =&gt; 'unknown', 'Online' =&gt; 'unknown', 'Product' =&gt; 'ProFTPd')
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodgetSoftLimit">FTP_Controller::getSoftLimit()</a>
  </dt>
  <dd>
    Gets the soft limit for a FTP user
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodkillAllConnections">FTP_Controller::killAllConnections()</a>
  </dt>
  <dd>
    Kills all connections
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodkillConnection">FTP_Controller::killConnection()</a>
  </dt>
  <dd>
    Kills a FTP session by its connection_id (returned from listConnections)
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodlistConnections">FTP_Controller::listConnections()</a>
  </dt>
  <dd>
    Returns a list of connections
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodlistControllers">FTP_Controller::listControllers()</a>
  </dt>
  <dd>
    Returns the list of support controllers
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodlistUsers">FTP_Controller::listUsers()</a>
  </dt>
  <dd>
    Return a list of FTP users
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodloadControllers">FTP_Controller::loadControllers()</a>
  </dt>
  <dd>
    Ths function loads all relevant controllers
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodRegister">FTP_Controller::Register()</a>
  </dt>
  <dd>
    Register Controller class $ControllerClass
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodsetConfigFields">FTP_Controller::setConfigFields()</a>
  </dt>
  <dd>
    Sets the configuration
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodsetQuota">FTP_Controller::setQuota()</a>
  </dt>
  <dd>
    Sets the hd quota of a certain user  When $SoftLimit is &gt; $HardLimit then $HardLimit will be set equal with $HardLimit
  </dd>
    <dt>
    <a href="../default/FTP_Controller.html#methodstartInterface">FTP_Controller::startInterface()</a>
  </dt>
  <dd>
    Ask to start interfacing with the FTP server using the configuration  set by setConfigFields  OR by supplying $Configuration
  </dd>
  </dl>
<h4>Class: <a href="../default/Controller.html">Controller</a></h4>
<dl>
    <dt>
    <a href="../default/Controller.html#methodcreateController">Controller::createController()</a>
  </dt>
  <dd>
    Creates a new instance of $ControllerClass if $Persistent is set to false
  </dd>
    <dt>
    <a href="../default/Controller.html#methodcreateController">Controller::createController()</a>
  </dt>
  <dd>
    Creates a new instance of $ControllerClass if $Persistent is set to false
  </dd>
    <dt>
    <a href="../default/Controller.html#methodlistControllers">Controller::listControllers()</a>
  </dt>
  <dd>
    Returns the list of support controllers
  </dd>
    <dt>
    <a href="../default/Controller.html#methodloadControllers">Controller::loadControllers()</a>
  </dt>
  <dd>
    Ths function loads all relevant controllers
  </dd>
    <dt>
    <a href="../default/Controller.html#methodRegister">Controller::Register()</a>
  </dt>
  <dd>
    Register Controller class $ControllerClass
  </dd>
  </dl>
</div>
</td>

</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 40]<br />
Controller frontend to a ProFTPd with MySQL support build in<br /><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodcanDisable"></a>
	<h3>method canDisable <span class="smalllinenumber">[line 190]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean canDisable(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return true if the controller can disable/enable ftp accounts<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodcanDisable">FTP_Controller::canDisable()</a> (Return true if the controller can disable/enable ftp accounts)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcanHandleQuota"></a>
	<h3>method canHandleQuota <span class="smalllinenumber">[line 182]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean canHandleQuota(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return true if the controller can handle quotas<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodcanHandleQuota">FTP_Controller::canHandleQuota()</a> (Return true if the controller can handle quotas)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcanKillConnections"></a>
	<h3>method canKillConnections <span class="smalllinenumber">[line 174]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean canKillConnections(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return true if the controller can kill a ftp connections<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodcanKillConnections">FTP_Controller::canKillConnections()</a> (Return true if the controller can kill a ftp connections)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcanListConnections"></a>
	<h3>method canListConnections <span class="smalllinenumber">[line 166]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean canListConnections(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return true if the controller can list current ftp connections<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodcanListConnections">FTP_Controller::canListConnections()</a> (Return true if the controller can list current ftp connections)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcreateUser"></a>
	<h3>method createUser <span class="smalllinenumber">[line 53]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void createUser(
string
$Username, string
$Password, string
$Homedir, [integer
$UID = 0], [integer
$GID = 0], [boolean
$Enabled = true])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Creates a new FTP user with the given $Homedir<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodcreateUser">FTP_Controller::createUser()</a> (Creates a new FTP user with the given $Homedir)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Password</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Homedir</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$UID</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$GID</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$Enabled</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddeleteUser"></a>
	<h3>method deleteUser <span class="smalllinenumber">[line 63]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean deleteUser(
string
$Username, [boolean
$KeepFiles = true])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Delete the given user<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methoddeleteUser">FTP_Controller::deleteUser()</a> (Delete the given user)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$KeepFiles</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddisableUser"></a>
	<h3>method disableUser <span class="smalllinenumber">[line 72]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean disableUser(
string
$Username)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Disable the given user<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methoddisableUser">FTP_Controller::disableUser()</a> (Disable the given user)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodenableUser"></a>
	<h3>method enableUser <span class="smalllinenumber">[line 81]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean enableUser(
string
$Username)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Enable the given user<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodenableUser">FTP_Controller::enableUser()</a> (Enable the given user)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodendInterface"></a>
	<h3>method endInterface <span class="smalllinenumber">[line 237]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean endInterface(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Stop interfacing with the FTP server<br /><br /><p>Should be called in a __destruct() function</p><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodendInterface">FTP_Controller::endInterface()</a> (Stop interfacing with the FTP server)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetConfigFields"></a>
	<h3>method getConfigFields <span class="smalllinenumber">[line 203]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getConfigFields(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns an array of the information that is needed to handle the ftp server (db_name and so on)<br /><br /><p>Example result:</p><p>$Array[0] = array('Name' =&gt; 'Server', 'Description' =&gt; 'The FTP server to connect to', 'Required' =&gt; false)  $Array[1] = array('Name' =&gt; 'Username', 'Description' =&gt; 'The username', 'Required' =&gt; false)</p><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodgetConfigFields">FTP_Controller::getConfigFields()</a> (Returns an array of the information that is needed to handle the ftp server (db_name and so on))<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetControllerInfo"></a>
	<h3>method getControllerInfo <span class="smalllinenumber">[line 245]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getControllerInfo(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Should return an array like this return array('Name' =&gt; 'FTP Controller', 'Description' =&gt; 'A FTP Controller');<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodgetControllerInfo">FTP_Controller::getControllerInfo()</a> (Should return an array like this return array('Name' =&gt; 'FTP Controller', 'Description' =&gt; 'A FTP Controller');)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetHardLimit"></a>
	<h3>method getHardLimit <span class="smalllinenumber">[line 121]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getHardLimit(
string
$Username)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Gets the hard limit for a FTP user<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodgetHardLimit">FTP_Controller::getHardLimit()</a> (Gets the hard limit for a FTP user)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetServerStatus"></a>
	<h3>method getServerStatus <span class="smalllinenumber">[line 130]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getServerStatus(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns information about the ftp server  Every class should return array('Version' =&gt; 'unknown', 'Online' =&gt; 'unknown', 'Product' =&gt; 'ProFTPd')<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodgetServerStatus">FTP_Controller::getServerStatus()</a> (Returns information about the ftp server  Every class should return array('Version' =&gt; 'unknown', 'Online' =&gt; 'unknown', 'Product' =&gt; 'ProFTPd'))<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetSoftLimit"></a>
	<h3>method getSoftLimit <span class="smalllinenumber">[line 112]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getSoftLimit(
string
$Username)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Gets the soft limit for a FTP user<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodgetSoftLimit">FTP_Controller::getSoftLimit()</a> (Gets the soft limit for a FTP user)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodkillAllConnections"></a>
	<h3>method killAllConnections <span class="smalllinenumber">[line 158]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void killAllConnections(
[string
$Username = ''])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Kills all connections<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodkillAllConnections">FTP_Controller::killAllConnections()</a> (Kills all connections)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td>if this is not empty, only the ftp connections for the given user will be killed</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodkillConnection"></a>
	<h3>method killConnection <span class="smalllinenumber">[line 149]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean killConnection(
integer
$ConnectionID, [string
$Username = ''])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Kills a FTP session by its connection_id (returned from listConnections)<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodkillConnection">FTP_Controller::killConnection()</a> (Kills a FTP session by its connection_id (returned from listConnections))<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$ConnectionID</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td>if this empty no checking on the owner of the process will be done</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodlistConnections"></a>
	<h3>method listConnections <span class="smalllinenumber">[line 139]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array listConnections(
[string
$Username = ''])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns a list of connections<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>of array ('id' =&gt; '', 'command' =&gt; '', 'time' =&gt; 0)</td>
  </tr>
</table>
</div>
<br /><br />

Overrides <a href="../default/FTP_Controller.html#methodlistConnections">FTP_Controller::listConnections()</a> (Returns a list of connections)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td>if not empty, only the connections for this user will be returned</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodlistUsers"></a>
	<h3>method listUsers <span class="smalllinenumber">[line 91]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean listUsers(
[integer
$From = 0], [integer
$Limit = 0])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Return a list of FTP users<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodlistUsers">FTP_Controller::listUsers()</a> (Return a list of FTP users)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$From</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$Limit</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetConfigFields"></a>
	<h3>method setConfigFields <span class="smalllinenumber">[line 214]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean setConfigFields(
[array
$Configuration = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the configuration<br /><br /><p>To know what kind of configuration options there are, check getConfigFields()</p><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodsetConfigFields">FTP_Controller::setConfigFields()</a> (Sets the configuration)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$Configuration</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetQuota"></a>
	<h3>method setQuota <span class="smalllinenumber">[line 103]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean setQuota(
string
$Username, [integer
$SoftLimit = 0], [integer
$HardLimit = 0])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the hd quota of a certain user  When $SoftLimit is &gt; $HardLimit then $HardLimit will be set equal with $HardLimit<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodsetQuota">FTP_Controller::setQuota()</a> (Sets the hd quota of a certain user  When $SoftLimit is &gt; $HardLimit then $HardLimit will be set equal with $HardLimit)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$Username</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$SoftLimit</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$HardLimit</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodstartInterface"></a>
	<h3>method startInterface <span class="smalllinenumber">[line 224]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean startInterface(
[variable
$Configuration = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Ask to start interfacing with the FTP server using the configuration  set by setConfigFields  OR by supplying $Configuration<br /><br /><br /><br />

Overrides <a href="../default/FTP_Controller.html#methodstartInterface">FTP_Controller::startInterface()</a> (Ask to start interfacing with the FTP server using the configuration  set by setConfigFields  OR by supplying $Configuration)<br /><br />
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">variable&nbsp;&nbsp;</td>
        <td><b>$Configuration</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Fri, 13 Oct 2006 03:48:25 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>